/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable.events;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;

import cgl.narada.matching.Profile;
import cgl.narada.matching.ProfileReconstructor;

/** This class is used to encapsulate information that a subscriber woould
    need to recover after a failure or a prolonged disconnect. This class
    includes information about both, the ACK response (sync point advance
    and missed sequences) and also the list of profiles that this client
    has registered to.
    
    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public class RdSubscriberRecoveryInfo {
  
  private RdAckResponseServiceInvoiceEvent ackResponse;

  private Profile[] profiles = null;

  private int entityId;

  private int templateId;

  private boolean hasProfileInfo = true;

  private String moduleName = "RdSubscriberRecoveryInfo: ";

  public RdSubscriberRecoveryInfo(int templateId, int entityId,
				  RdAckResponseServiceInvoiceEvent ackResponse,
				  Profile[] profiles) {

    this.templateId = templateId;
    this.entityId = entityId;
    this.ackResponse = ackResponse;
    this.profiles = profiles;
    
    if (profiles == null) {
      hasProfileInfo = false;
    } else {
      if (profiles.length == 0){
	hasProfileInfo = false;
      }
    }
    
  }
  
  
  public int getEntityId() {
    return entityId;
  }
  
  
  public int getTemplateId() {
    return templateId;
  }

  public RdAckResponseServiceInvoiceEvent getAckResponse() {
    return ackResponse;
  }
  
  public boolean containsProfileInfo() {
    return hasProfileInfo;
  }
  
  public Profile[] getRegisteredProfiles() {
    return profiles;
  }
  
  public String toString() {
    String stringRep = moduleName + ackResponse.toString();
    if (hasProfileInfo) {
      stringRep += "\nThe following profiles were previously registered";
      for (int i=0; i <profiles.length; i++) {
	stringRep += ( profiles[i] + "\n");
      }/* end for */
    } else {
      stringRep += ". No profiles were previously registered";
    } /* if (hasProfileInfo) */

    return stringRep;
  }
  
  /** Reconstructing the original event from its serialized representation */
  public RdSubscriberRecoveryInfo(byte[] marshalledBytes) {
    ByteArrayInputStream baInputStream = 
      new ByteArrayInputStream(marshalledBytes);
    DataInputStream din = new DataInputStream(baInputStream);
    
    try {
      templateId = din.readInt();
      entityId = din.readInt();
      
      byte[] ackResponseBytes = new byte[din.readInt()];
      din.readFully(ackResponseBytes);
      ackResponse = new RdAckResponseServiceInvoiceEvent(ackResponseBytes);
      
      hasProfileInfo = din.readBoolean();
      
      if (!hasProfileInfo) {
	return;
      }
      
      int numOfProfiles = din.readInt();
      profiles = new Profile[numOfProfiles];
      
      for (int i=0; i < numOfProfiles; i++) {
	byte[] profileBytes = new byte[din.readInt()];
	int profileType = din.readInt();
	din.readFully(profileBytes);
	profiles[i] = 
	  ProfileReconstructor.getProfile(profileType, profileBytes);
      }
      
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while un-marshalling");
    }

  }

  
  /** Returns a serialized representation of the event bytes */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);
    byte[] marshalledBytes= null;

    try {
      dout.writeInt(templateId);
      dout.writeInt(entityId);
      
      byte[] ackResponseBytes = ackResponse.getBytes();
      dout.writeInt(ackResponseBytes.length);
      dout.write(ackResponseBytes);
      
      dout.writeBoolean(hasProfileInfo);
      if (hasProfileInfo) {
	int numOfProfiles = profiles.length;
	dout.writeInt(numOfProfiles);
	
	for (int i=0; i < numOfProfiles; i++) {
	  Profile profile = profiles[i];
	  byte[] profileBytes = profile.getBytes();
	  
	  dout.writeInt(profileBytes.length);
	  dout.writeInt(profile.getProfileType());
	  dout.write(profileBytes);
	}/* end for */

      }/* end if */
      
      dout.flush();
      marshalledBytes = baOutputStream.toByteArray();
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while marshalling");
    }
    return marshalledBytes;
  }
  
}
